mnemonist

What is mnemonist?

The mnemonist package is a collection of data structures for JavaScript and TypeScript. It provides a variety of advanced data structures that are not available in the standard JavaScript library, allowing developers to handle complex data manipulation tasks more efficiently.

What are mnemonist's main functionalities?

FibonacciHeap

FibonacciHeap is a heap data structure that allows for efficient retrieval and modification of the minimum element. It is particularly efficient for mergeable heap operations.

const { FibonacciHeap } = require('mnemonist');
const heap = new FibonacciHeap();
heap.push(3, 'three');
heap.push(1, 'one');
heap.pop(); // -> 'one'

Trie

Trie is a tree-like data structure that is used to store a dynamic set or associative array where the keys are usually strings. It is useful for tasks like autocomplete where prefix-based search is needed.

const { Trie } = require('mnemonist');
const trie = new Trie();
trie.add('cat');
trie.add('can');
trie.has('cat'); // -> true

SuffixArray

SuffixArray is a data structure that provides an efficient way to search for substrings within a given string. It is useful for text processing and search applications.

const { SuffixArray } = require('mnemonist');
const suffixArray = new SuffixArray('banana');
suffixArray.search('ana'); // -> [1, 3]

BKTree

BKTree is a tree data structure for approximate string matching. It is useful for spell checking, fuzzy searching, and other applications where you need to find strings that are similar to a target string.

const { BKTree } = require('mnemonist');
const tree = new BKTree(levenshtein);
tree.add('book');
tree.add('back');
tree.search('bock', 2); // -> [{word: 'book', distance: 1}, {word: 'back', distance: 1}]

Other packages similar to mnemonist

immutable

Immutable.js offers a wide range of persistent immutable data structures. Unlike mnemonist, which provides a mix of both mutable and immutable structures, Immutable.js focuses solely on immutable structures, which can be beneficial for certain functional programming paradigms.

lodash

Lodash is a utility library that provides a lot of the same functionality as mnemonist in terms of data manipulation, but it does not offer the same range of advanced data structures. Lodash is more focused on utility functions for common tasks.

collect.js

Collect.js is a dependency-free wrapper for working with arrays and objects that mimics Laravel Collections. While it provides a fluent interface for manipulating collections of data, it does not offer the specialized data structures that mnemonist does.

README

Mnemonist

Mnemonist is a curated collection of data structures for the JavaScript language.

It gathers classic data structures (think heap, trie etc.) as well as more exotic ones such as Buckhard-Keller trees etc.

It strives at being:

• As performant as possible for a high-level language.
• Completely modular (don't need to import the whole library just to use a simple heap).
• Simple & straightforward to use and consistent with JavaScript standard objects' API.
• Completely typed and comfortably usable with Typescript.

Installation

npm install --save mnemonist

Documentation

Full documentation for the library can be found here.

Classics

• Heap
• Linked List
• LRUCache, LRUMap
• MultiMap
• MultiSet
• Queue
• Set (helpers)
• Stack
• Trie
• TrieMap

Low-level & structures for very specific use cases

• Circular Buffer
• Fixed Deque
• Fibonacci Heap
• Fixed Reverse Heap
• Fixed Stack
• Hashed Array Tree
• Static DisjointSet
• SparseQueueSet
• SparseMap
• SparseSet
• Suffix Array
• Generalized Suffix Array
• Vector

Information retrieval & Natural language processing

• Fuzzy Map
• Fuzzy MultiMap
• Inverted Index
• Passjoin Index
• SymSpell

Space & time indexation

• Static IntervalTree
• KD-Tree

Metric space indexation

• Burkhard-Keller Tree
• Vantage Point Tree

Probabilistic & succinct data structures

• BitSet
• BitVector
• Bloom Filter

Utility classes

• BiMap
• DefaultMap
• DefaultWeakMap

---

Note that this list does not include a Graph data structure, whose implementation is usually far too complex for the scope of this library.

However, we advise the reader to take a look at the graphology library instead.

Don't find the data structure you need? Maybe we can work it out together.

Contribution

Contributions are obviously welcome. Be sure to lint the code & add relevant unit tests.

# Installing
git clone [e-mail]:Yomguithereal/mnemonist.git
cd mnemonist
npm install

# Linting
npm run lint

# Running the unit tests
npm test

License

MIT